Get Workspace
Get Workspace
Path Parameters
Response
idstring
Id of the Workspace.
realmstring
Name of the workspace.
realmLogostring
Logo of the workspace.
workspacestring
Workspace URL.
notBeforenumber
Not before timestamp value.
revokeRefreshTokenboolean
true/false for revoke refresh token.
refreshTokenMaxReusenumber
Max reuse of the refresh token.
accessTokenLifespannumber
Lifespan of access token.
accessTokenLifespanForImplicitFlownumber
Lifespan for implicit flow access token.
ssoSessionIdleTimeoutnumber
Timeout of sso session Idle.
ssoSessionMaxLifespannumber
Lifespan of sso session.
ssoSessionIdleTimeoutRememberMenumber
Timeout for sso session idle remember me.
ssoSessionMaxLifespanRememberMenumber
Max lifespan for sso session remember me.
offlineSessionIdleTimeoutnumber
Timeout of idle offline session.
offlineSessionMaxLifespanEnabledboolean
true/false for offline session max lifespan.
offlineSessionMaxLifespannumber
Max lifespan of offline session.
clientSessionIdleTimeoutnumber
Timeout of client idle session.
clientSessionMaxLifespannumber
Max lifespan client session.
clientOfflineSessionIdleTimeoutnumber
Timeout of client idle offline session.
clientOfflineSessionMaxLifespannumber
Max Lifespan of client offline session.
accessCodeLifespannumber
Lifespan of access code.
accessCodeLifespanUserActionnumber
Lifespan of access code user action.
accessCodeLifespanLoginnumber
Lifespan of access code in login.
actionTokenGeneratedByAdminLifespannumber
Lifespan of action token generated by admin.
actionTokenGeneratedByUserLifespannumber
Lifespan of action token generated by user.
enabledboolean
true/false for enabled or not.
sslRequiredstring
true/false for ssl required or not.
verifyEmailboolean
true/false verify email.
loginWithEmailAllowedboolean
true/false for login with email allowed or not.
duplicateEmailsAllowedboolean
true/false from duplicate email allowed or not.
editUsernameAllowedboolean
true/false for edit user name allowed or not.
userInviteWaystring
User invite way.
bruteForceProtectedboolean
true/false brute force protected.
permanentLockoutboolean
true/false permanent lockout or not.
maxFailureWaitSecondsnumber
Max failure for wait seconds.
minimumQuickLoginWaitSecondsnumber
Minimum quick login wait seconds.
waitIncrementSecondsnumber
Wait increment seconds.
quickLoginCheckMilliSecondsnumber
Quick Login check milliseconds.
maxDeltaTimeSecondsnumber
Max delta time seconds.
failureFactornumber
Failure factor.
enabledOwnEmailProviderboolean
true/false for own email provider enabled or not.
enabledOwnSmsProviderboolean
true/false for own sms provider enabled or not.
defaultRolesarray
Array of default roles
requiredCredentialsarray
Array of require credentials.
otpPolicyTypestring
Otp policy type.
otpPolicyAlgorithmstring
Otp policy algorithm.
otpPolicyInitialCounternumber
Initial count of opt policy.
otpPolicyDigitsnumber
Digits of otp policy
otpPolicyLookAheadWindownumber
Otp policy look ahead window value.
otpPolicyPeriodnumber
Period of otp policy
otpSupportedApplicationsarray
Applications supported otp.
webAuthnPolicyRpEntityNamestring
EntityName of webauthn policyrp
webAuthnPolicySignatureAlgorithmsarray
Array of webauthn policy signature algorithms.
webAuthnPolicyRpIdstring
Webauthn policyrp id
webAuthnPolicyAttestationConveyancePreferencestring
webAuth policy attestation conveyance preference.
webAuthnPolicyAuthenticatorAttachmentstring
Attachment of webauthn policy authenticator.
webAuthnPolicyRequireResidentKeystring
Webauthn policy require resident key.
webAuthnPolicyUserVerificationRequirementstring
Webauthn policy user verification requirement.
webAuthnPolicyCreateTimeoutnumber
webauthn policy create timeout.
webAuthnPolicyAvoidSameAuthenticatorRegisterboolean
true/false for webauthn policy avoids same authenticator register.
webAuthnPolicyAcceptableAaguidsarray
Array of webauthn policy acceptable aaguids.
webAuthnPolicyPasswordlessRpEntityNamestring
webauthn policy passwordlessrp enityname.
webAuthnPolicyPasswordlessSignatureAlgorithmsarray
Array of webauthn policy passwordless signature algorithms
webAuthnPolicyPasswordlessRpIdstring
Webauthn policy passwordless rp id.
webAuthnPolicyPasswordlessAttestationConveyancePreferencestring
webauthn policy passwordless attestation conveyance preference.
webAuthnPolicyPasswordlessAuthenticatorAttachmentstring
webauthn policy passwordless authenticator attachment.
webAuthnPolicyPasswordlessRequireResidentKeystring
webauthn policy passwordless requires resident key.
webAuthnPolicyPasswordlessUserVerificationRequirementstring
Webauthn policy passwordless user verification requirement.
webAuthnPolicyPasswordlessCreateTimeoutnumber
webauthn policy passwordless create timeout.
webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegisterboolean
true/false webauthn policy passwordless avoid same authenticator register.
webAuthnPolicyPasswordlessAcceptableAaguidsarray
array of webauthn policy passwordless acceptable aaguids
browserSecurityHeadersobject
Browser security headers.
smtpServerobject
Smtp servers.
smsServerobject
SMS servers
loginThemestring
Login theme.
accountThemestring
account theme
adminThemestring
Admin theme
emailThemestring
email theme
eventsEnabledboolean
true/false events enabled or not.
mfaProvidersarray
Array of mfa provides,
eventsListenersarray
Array of event listeners.
enabledEventTypesarray
Array of enabled event types
adminEventsEnabledboolean
true/false admin events enabled or not.
adminEventsDetailsEnabledboolean
true/false admin events details enabled or not.
identityProvidersarray
Array of identity providers
identityProviderMappersarray
Array of identity provider mappers.
internationalizationEnabledboolean
true/false for internationalization enabled or not.
supportedLocalesarray
Array of supported locales
browserFlowstring
Browser flow name.
registrationFlowstring
Registration flow name.
directGrantFlowstring
Direct grant flow name.
resetCredentialsFlowstring
Reset credential flow name.
clientAuthenticationFlowstring
Client authentication flow name.
dockerAuthenticationFlowstring
Docker authentication flow name.
attributesobject
Attributes.
userManagedAccessAllowedboolean
true/false user managed access allowed or not.
liveboolean
true/false workspace live or not.
{
"id": "c9542c4b-df69-4153-a411-a0dd6b84d3b3",
"realm": "grootan",
"displayName": "eztoauth",
"workspace": "http://localhost:8080",
"hasCustomDomain": false,
"defaultRegion": "in",
"notBefore": 0,
"defaultSignatureAlgorithm": "RS256",
"revokeRefreshToken": false,
"refreshTokenMaxReuse": 0,
"accessTokenLifespan": 518400,
"accessTokenLifespanForImplicitFlow": 518400,
"ssoSessionIdleTimeout": 1800,
"ssoSessionMaxLifespan": 36000,
"ssoSessionIdleTimeoutRememberMe": 0,
"ssoSessionMaxLifespanRememberMe": 0,
"offlineSessionIdleTimeout": 2592000,
"offlineSessionMaxLifespanEnabled": false,
"offlineSessionMaxLifespan": 5184000,
"clientSessionIdleTimeout": 0,
"clientSessionMaxLifespan": 0,
"clientOfflineSessionIdleTimeout": 0,
"clientOfflineSessionMaxLifespan": 0,
"accessCodeLifespan": 60,
"accessCodeLifespanUserAction": 300,
"accessCodeLifespanLogin": 1800,
"actionTokenGeneratedByAdminLifespan": 43200,
"actionTokenGeneratedByUserLifespan": 300,
"oauth2DeviceCodeLifespan": 600,
"oauth2DevicePollingInterval": 600,
"enabled": true,
"sslRequired": "external",
"registrationAllowed": true,
"registrationEmailAsUsername": false,
"rememberMe": false,
"verifyEmail": false,
"loginWithEmailAllowed": true,
"duplicateEmailsAllowed": false,
"duplicateMobNumAllowed": true,
"resetPasswordAllowed": true,
"editUsernameAllowed": false,
"userInviteWay": "otp",
"userInviteClientId": "sso",
"bruteForceProtected": false,
"permanentLockout": false,
"maxFailureWaitSeconds": 900,
"minimumQuickLoginWaitSeconds": 60,
"waitIncrementSeconds": 60,
"quickLoginCheckMilliSeconds": 1000,
"maxDeltaTimeSeconds": 43200,
"failureFactor": 30,
"enabledOwnEmailProvider": true,
"enabledOwnSmsProvider": true,
"defaultRoles": [
"user",
"offline_access",
"uma_authorization"
],
"requiredCredentials": [
"password"
],
"passwordPolicy": "passwordHistory(3) and length(8) and notUsername(undefined) and notEmail(undefined) and upperCase(1) and specialChars(1) and digits(1)",
"otpPolicyType": "totp",
"otpPolicyAlgorithm": "HmacSHA1",
"otpPolicyInitialCounter": 0,
"otpPolicyDigits": 6,
"otpPolicyLookAheadWindow": 1,
"otpPolicyPeriod": 30,
"otpSupportedApplications": [
"FreeOTP",
"Google Authenticator"
],
"webAuthnPolicyRpEntityName": "keycloak",
"webAuthnPolicySignatureAlgorithms": [
"ES256"
],
"webAuthnPolicyRpId": "",
"webAuthnPolicyAttestationConveyancePreference": "not specified",
"webAuthnPolicyAuthenticatorAttachment": "not specified",
"webAuthnPolicyRequireResidentKey": "not specified",
"webAuthnPolicyUserVerificationRequirement": "not specified",
"webAuthnPolicyCreateTimeout": 0,
"webAuthnPolicyAvoidSameAuthenticatorRegister": false,
"webAuthnPolicyAcceptableAaguids": [],
"webAuthnPolicyPasswordlessRpEntityName": "keycloak",
"webAuthnPolicyPasswordlessSignatureAlgorithms": [
"ES256"
],
"webAuthnPolicyPasswordlessRpId": "",
"webAuthnPolicyPasswordlessAttestationConveyancePreference": "not specified",
"webAuthnPolicyPasswordlessAuthenticatorAttachment": "not specified",
"webAuthnPolicyPasswordlessRequireResidentKey": "not specified",
"webAuthnPolicyPasswordlessUserVerificationRequirement": "not specified",
"webAuthnPolicyPasswordlessCreateTimeout": 0,
"webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister": false,
"webAuthnPolicyPasswordlessAcceptableAaguids": [],
"browserSecurityHeaders": {
"contentSecurityPolicyReportOnly": "",
"xContentTypeOptions": "nosniff",
"xRobotsTag": "none",
"xFrameOptions": "SAMEORIGIN",
"contentSecurityPolicy": "frame-src 'self' https://wchat.in.freshchat.com/ https://www.google.com/ https://app.tango.us/ https://www.youtube.com/ ; frame-ancestors 'self'; object-src 'none';",
"strictTransportSecurity": "max-age=31536000; includeSubDomains"
},
"smtpServer": {},
"smsServer": {},
"loginTheme": "qlik_verify",
"accountTheme": "qlik_verify",
"adminTheme": "qlik_verify",
"emailTheme": "qlik_verify",
"mode": "wiam",
"eventsEnabled": true,
"mfaProviders": [],
"eventsListeners": [
"google-ws-sync",
"okta-ws-sync",
"azure-sync",
"duo-ws-sync",
"webhook-streamer",
"jboss-logging",
"email",
"report-listener"
],
"enabledEventTypes": [
"LOGOUT",
"REGISTER",
"LOGIN_ERROR",
"OKTA_WS_SYNC_SUCCESS",
"REGISTER_ERROR",
"LOGOUT_ERROR",
"LOGIN",
"AZURE_SYNC_SUCCESS",
"DUO_WS_SYNC_SUCCESS",
"GOOGLE_WS_SYNC_SUCCESS"
],
"adminEventsEnabled": true,
"adminEventsDetailsEnabled": false,
"identityProviders": [],
"identityProviderMappers": [],
"internationalizationEnabled": false,
"supportedLocales": [],
"browserFlow": "browser",
"registrationFlow": "registration",
"directGrantFlow": "direct grant",
"resetCredentialsFlow": "reset credentials",
"clientAuthenticationFlow": "clients",
"dockerAuthenticationFlow": "docker auth",
"attributes": {
"cibaBackchannelTokenDeliveryMode": "hook-notifier",
"KEYLESS_CUSTOMER": "eztoauth_poc",
"dashboardLocale": "en",
"clientOfflineSessionIdleTimeout": "0",
"PINDROP_SCORE_THRESHOLD": "50.0",
"cibaExpiresIn": "120",
"PINDROP_EXPIRY_TIME": "20",
"onboarding-steps-completed": "ob-admin-setup,ob-admin-email-setup,ob-admin-sms-setup,ob-admin-whatsapp-setup,ob-admin-workspace-setup,ob-admin-audit-setup,ob-admin-audit-streamer-setup,qv-bruteforce-detection,ob-admin-security-defenses-setup",
"profileLocale": "en",
"KEYLESS_ONBOARDING_TOKEN": "",
"cibaAuthRequestedUserHint": "user",
"MIRACL_PROJECT_APP_CLIENT_ID": "",
"oauth2DevicePollingInterval": "600",
"clientOfflineSessionMaxLifespan": "0",
"clientSessionIdleTimeout": "0",
"MIRACL_PROJECT_APP_CLIENT_SECRET": "",
"defaultRegion": "in",
"KEYLESS_LOGIN_TOKEN": "",
"cibaInterval": "5",
"oauth2DeviceCodeLifespan": "600",
"KEYLESS_HOST": "https://middleware-api.external.core-production.keyless.technology",
"inviteOnly": "false",
"KEYLESS_EXPIRY_TIME": "30m",
"clientSessionMaxLifespan": "0",
"PINDROP_HOST": "https://prd.us.identity.pindrop",
"parRequestUriLifespan": "60",
"PINDROP_TOKEN": "",
"rememberMe": "true",
"loginLocale": "en"
},
"userManagedAccessAllowed": true,
"authenticationFlowBindingOverrides": {
"onboarding": "68df5301-f94c-4aea-8db0-4d64b7f6299a"
},
"appConnections": {},
"mfaConnections": {},
"dnsenabled": true,
"live": false
}
| HTTP STATUS CODE SUMMARY | ||
|---|---|---|
| 200 - OK | Successfully done. | |
| 201 - OK | Successfully created. | |
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. | |
| 401 - Unauthorized | Unauthorized access try with correct access. | |
| 402 - Request Failed | The parameters were valid but the request failed. | |
| 403 - Forbidden | The Application doesn't have permissions to perform the request. | |
| 404 - Not Found | The requested resource doesn't exist | |
| 500 - Server Errors | Something went wrong on ezto auth's end. (These are rare.) | |
| 503 - Server Errors | Service temporarily unavailable |